GET Channel Detailed

Overview

---

The table below provides key details about the GET method for retrieving a specified channel with details.

Get a Single Channel- Channel Detailed
Method	GET
URL or Endpoint	/api/v1/projectId/channels/publicId
Headers	Authorization
Parameters	publicId, projectId

The description of the URL parameter is as follows:

publicId URL Parameter
URL Parameter Name	publicId
Mandatory	Yes
Type	string
Description	Unique Id of the channel.

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

The request does not have a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "{channelId}",
    "name": "{channelName}",
    "title": "{channelTitle}",
    "logo": null,
    "streamServer": "rtmp://{streamServerLink]",
    "streamKey": "{streamKey}",
    "playbackUrl": "",
    "source": null,
    "liveStatus": "Offline",
    "healthStatus": "Unknown",
    "type": "Standard",
    "typeId": 1,
    "latencyType": "Normal",
    "latencyTypeId": 1,
    "inputType": "RtmpPull",
    "filePath": "rtmp://{linkToPlayRTMP}"
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
publicId	string	Returns the public identifier of the channel
name	string	Returns a guid that is randomly generated
title	string	Returns the title of the channel
logo	string($binary)	Returns the URL for the channel's logo
streamServer	string	Returns the RTMP URL of the streaming server where live channel streams should be directed for ingestion
streamKey	string	Returns a unique identifier which is used to authenticate and identify a specific live stream on the streaming platform
playbackUrl	string	Returns a m3u8 file URL where the livestream can be accessed for playback
source	string	Returns the location from which the live stream is being streamed
liveStatus	string	Indicate the live status of the channel
healthStatus	string	Indicate the health status of the channel
type	string	Returns ingestion Type of RTMP(Real Time Messaging Protocol)
typeId	integer($int32)	Indicate unique identifier for ingestion type of RTMP
latencyType	string	Returns the type of latency chosen during the creation of the channel
latencyTypeId	integer($int32)	Indicates the unique identifier for the latency type of the channel
inputType	string	Returns the selected RTMP type during the creation of the live channel
filePath	string	Indicates source URL from which the livestream is pulled/pushed from ingestion
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed